Release 10.1A: OpenEdge Development:
Progress Dynamics Basic Development

SBO files and properties

The SBO is a nonvisual Progress SmartContainer™ object, with a ContainerType property of VIRTUAL. A static SBO is based on a template file named ry\obj\rysttasboo.w, a variation of the standard SBO template src\adm2\template\sbo.w, and it has its own New item in the AppBuilder New menu list and its own button in the AppBuilder.

Note: They differ primarily in details of the wizard pages.

It has defined ADM-SUPPORTED-LINKS of Commit-Target, Data-Source, Data-Target, Update-Target, and Navigation-Target. Its Procedure-Type (which becomes the ObjectType ADM property) is SmartBusinessObject.

The SBO has these properties also found in the SDO:

AppService — (CHARACTER) Application Service (Partition) name. If this property is blank, then the property will be written to the Repository with the default value. The default value for AppService value is the same as for all data objects: "ASTRA". If you need a blank value here, edit the Repository with the ROM tool.
ASDivision — (CHARACTER) Client, Server, or blank.
ASHandle — (HANDLE) Handle of the SBO procedure running on the AppServer.
AutoCommit — (LOGICAL) TRUE if each save should be immediately committed (which is the default if there is no Commit-Source) or FALSE if changes should be accumulated in the Update temp-tables until an explicit commit is done (which is the default if there is a Commit-Source). If the SBO has multiple SDOs, unsaved changes in all SDOs are saved.
DataColumns — (CHARACTER) Comma-separated list of all columns in contained SDOs; this differs from the SDO format in that it is a single list where each column name is qualified by its SDO’s ObjectName.
ForeignFields — (CHARACTER) Mapping of Data-Source fields to MasterDataObject fields if there is a Data-Source for this SBO.
ForeignValues — (CHARACTER) List of the current values of ForeignFields (stored as a CHR(1)-delimited list of field values).
UpdateableColumns — (CHARACTER) Comma-separated list of all updateable columns from all contained SDOs; this differs from the SDO format in that each column name is qualified by its SDO’s ObjectName.
RowObjectState — (CHARACTER) NoUpdates or RowUpdated. Determines whether Commit-Source buttons are enabled.
CommitSource, CommitSourceEvents, NavigationSource, NavigationSourceEvents, DataTargetEvents — To support those links.

The SBO has these additional ADM properties not found in the SDO:

MasterDataObject — (HANDLE) Identifies the master SDO or top-level SDO contained in the SBO.
ObjectMapping — (CHARACTER) Maps the handles of client objects, including browsers, viewers, and toolbars, to the procedure handles of the SDOs they are associated with. This can include mapping browsers to the SDO whose query they are browsing, Navigation-Sources to the SDOs they are navigating, and viewers to the SDOs whose fields they are displaying. The format of this property is a comma-separated list of pairs, with the first entry in each pair being the client object handle and the second entry being the SDO handle. Because an SDO can be associated with more than one other object, there might be duplications in the list. This property is used, for example, to determine which object to pass a queryPosition event on to. This property is intended for internal use, though it is possible that application code might, under some special circumstances, want to make use of it.
ContainedDataColumns — (CHARACTER) A list of all of the DataColumns from all contained SDOs. Column names are not qualified and are in a set of comma-separated lists, one for each contained SDO, with the lists being further delimited by semicolons. This property is intended for internal use.
ContainedDataobjects — (CHARACTER) A comma-separated list of the handles of the SDOs contained in the SBO. This list, and others that list contained objects or their columns, are always kept in matching order (so that, for example, the nth entry in ContainedDataobjects is the handle of the nth entry in DataObjectNames; also, the nth sublist of column names in the ContainedDataColumns property is for the nth entry in ContainedDataobjects, and the nth list in ContainedDataColumns).
DataObjectNames — (CHARACTER) The ObjectNames of its contained SDOs as a comma-separated list.
DataObjectOrdering — (CHARACTER) This property, intended for internal use only, maps the order of the contained SDOs as defined by the AppBuilder-generated code to the order assigned either by organizing the objects in top-down Data link order (which happens during initialization if no other order has been assigned) or by using the user-defined update order as defined in the SBO property dialog box.
UpdateOrder (CHARACTER) — List of the contained SDOs in the order that an update operation will process them. It is user-settable at the SBO instance level. It can be set programatically or it can be set manually using the Instance Properties dialog box.

In addition, there is a getDataHandle function that returns the handle of the SDO query matching a browser that makes the request. There is also a getQueryPosition function, which returns the current QueryPosition setting for the contained SDO mapped to the requesting object.

Also, the following new SmartObject property is defined for all SmartObjects, and is used by SBOs in particular:

ObjectName — (CHARACTER) The logical name of the SmartObject. By default it is the simple filename of the SmartObject procedure, with no leading path and no file type extension. This property can be used to give distinctive and meaningful names to the SDOs contained in an SBO, and is set in the instance property dialog box of the SDO when placed in an SBO. This name becomes the name of the update temp-table (defined within the SDO as RowObjUpd) when referenced in the SBO. Giving a distinctive name to each SDO makes it easier to write business logic in the SBO that refers to all of the contained SDO’s updates.

The SBO has as its basic include file the file src\adm2\sbo.i. This includes the property include file src\adm2\sboprop.i and prototype file src\adm2\sboprto.i, along with the standard custom include files as well (using sbo as the base include filename).

The SBO starts the super procedure src\adm2\sbo.p. Procedures and functions described below are implemented in sbo.p unless otherwise noted.